<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SPHinXsys: SPH::DiffusionReaction&lt; BaseMaterialType &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">SPHinXsys
   &#160;<span id="projectnumber">alpha version</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespace_s_p_h.html">SPH</a></li><li class="navelem"><a class="el" href="class_s_p_h_1_1_diffusion_reaction.html">DiffusionReaction</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="class_s_p_h_1_1_diffusion_reaction-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">SPH::DiffusionReaction&lt; BaseMaterialType &gt; Class Template Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Complex material for diffusion or/and reactions.  
 <a href="class_s_p_h_1_1_diffusion_reaction.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="diffusion__reaction_8h_source.html">diffusion_reaction.h</a>&gt;</code></p>

<p>Inherits <a class="el" href="class_s_p_h_1_1_base_material_type.html">BaseMaterialType</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a1ffa4b3efb62dc2b8c7a4a453c7a49c1"><td class="memTemplParams" colspan="2">template&lt;typename... ConstructorArgs&gt; </td></tr>
<tr class="memitem:a1ffa4b3efb62dc2b8c7a4a453c7a49c1"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_diffusion_reaction.html#a1ffa4b3efb62dc2b8c7a4a453c7a49c1">DiffusionReaction</a> (StdVec&lt; std::string &gt; species_name_list, ConstructorArgs &amp;&amp;...args)</td></tr>
<tr class="separator:a1ffa4b3efb62dc2b8c7a4a453c7a49c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b8e08b31fcb4799d350314496a106ca"><td class="memTemplParams" colspan="2">template&lt;typename... ConstructorArgs&gt; </td></tr>
<tr class="memitem:a0b8e08b31fcb4799d350314496a106ca"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_diffusion_reaction.html#a0b8e08b31fcb4799d350314496a106ca">DiffusionReaction</a> (<a class="el" href="class_s_p_h_1_1_base_reaction_model.html">BaseReactionModel</a> &amp;species_reaction, StdVec&lt; std::string &gt; species_name_list, ConstructorArgs &amp;&amp;...args)</td></tr>
<tr class="separator:a0b8e08b31fcb4799d350314496a106ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4e6769a645966cf58e47c22cc5662c5"><td class="memItemLeft" align="right" valign="top"><a id="ab4e6769a645966cf58e47c22cc5662c5"></a>
<a class="el" href="classsize__t.html">size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>NumberOfSpecies</b> ()</td></tr>
<tr class="separator:ab4e6769a645966cf58e47c22cc5662c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb3042f99b202e503ab3f91759366cd5"><td class="memItemLeft" align="right" valign="top"><a id="adb3042f99b202e503ab3f91759366cd5"></a>
<a class="el" href="classsize__t.html">size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>NumberOfSpeciesDiffusion</b> ()</td></tr>
<tr class="separator:adb3042f99b202e503ab3f91759366cd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18c8ea178ba308f82e4a90860c39fbfb"><td class="memItemLeft" align="right" valign="top"><a id="a18c8ea178ba308f82e4a90860c39fbfb"></a>
StdVec&lt; <a class="el" href="class_s_p_h_1_1_base_diffusion.html">BaseDiffusion</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>SpeciesDiffusion</b> ()</td></tr>
<tr class="separator:a18c8ea178ba308f82e4a90860c39fbfb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe1c74aac60e794953c5c69de11867ae"><td class="memItemLeft" align="right" valign="top"><a id="abe1c74aac60e794953c5c69de11867ae"></a>
<a class="el" href="class_s_p_h_1_1_base_reaction_model.html">BaseReactionModel</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>SpeciesReaction</b> ()</td></tr>
<tr class="separator:abe1c74aac60e794953c5c69de11867ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00144042dc72df820654c42135a8fbdb"><td class="memItemLeft" align="right" valign="top"><a id="a00144042dc72df820654c42135a8fbdb"></a>
std::map&lt; std::string, <a class="el" href="classsize__t.html">size_t</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>SpeciesIndexMap</b> ()</td></tr>
<tr class="separator:a00144042dc72df820654c42135a8fbdb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a875f23433784c4779a1039555d09184b"><td class="memItemLeft" align="right" valign="top"><a id="a875f23433784c4779a1039555d09184b"></a>
StdVec&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>getSpeciesNameList</b> ()</td></tr>
<tr class="separator:a875f23433784c4779a1039555d09184b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a191e54df3930f1243256ba83082bd6d1"><td class="memItemLeft" align="right" valign="top"><a id="a191e54df3930f1243256ba83082bd6d1"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>assignBaseParticles</b> (<a class="el" href="class_s_p_h_1_1_base_particles.html">BaseParticles</a> *base_particles) override</td></tr>
<tr class="separator:a191e54df3930f1243256ba83082bd6d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d00a03cfc509812c4e0c27919318bd7"><td class="memItemLeft" align="right" valign="top"><a id="a4d00a03cfc509812c4e0c27919318bd7"></a>
Real&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_diffusion_reaction.html#a4d00a03cfc509812c4e0c27919318bd7">getDiffusionTimeStepSize</a> (Real smoothing_length)</td></tr>
<tr class="memdesc:a4d00a03cfc509812c4e0c27919318bd7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get diffusion time step size. Here, I follow the reference: <a href="https://www.uni-muenster.de/imperia/md/content/physik_tp/lectures/ws2016-2017/num_methods_i/heat.pdf">https://www.uni-muenster.de/imperia/md/content/physik_tp/lectures/ws2016-2017/num_methods_i/heat.pdf</a>. <br /></td></tr>
<tr class="separator:a4d00a03cfc509812c4e0c27919318bd7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0df9513e12beb9add4f6176b46d1b54"><td class="memTemplParams" colspan="2">template&lt;class DiffusionType , typename... ConstructorArgs&gt; </td></tr>
<tr class="memitem:ae0df9513e12beb9add4f6176b46d1b54"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_diffusion_reaction.html#ae0df9513e12beb9add4f6176b46d1b54">initializeAnDiffusion</a> (const std::string &amp;diffusion_species_name, const std::string &amp;gradient_species_name, ConstructorArgs &amp;&amp;...args)</td></tr>
<tr class="separator:ae0df9513e12beb9add4f6176b46d1b54"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ce668264c1fa291a91755f3537a0bea"><td class="memItemLeft" align="right" valign="top"><a id="a4ce668264c1fa291a91755f3537a0bea"></a>
virtual <a class="el" href="class_s_p_h_1_1_diffusion_reaction.html">DiffusionReaction</a>&lt; <a class="el" href="class_s_p_h_1_1_base_material_type.html">BaseMaterialType</a> &gt; *&#160;</td><td class="memItemRight" valign="bottom"><b>ThisObjectPtr</b> () override</td></tr>
<tr class="separator:a4ce668264c1fa291a91755f3537a0bea"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:ab27005a91c379e65460f62d5343e9bf3"><td class="memItemLeft" align="right" valign="top"><a id="ab27005a91c379e65460f62d5343e9bf3"></a>
StdVec&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>species_name_list_</b></td></tr>
<tr class="separator:ab27005a91c379e65460f62d5343e9bf3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19f730bebdeedd4bf8add8a4f10d10a7"><td class="memItemLeft" align="right" valign="top"><a id="a19f730bebdeedd4bf8add8a4f10d10a7"></a>
<a class="el" href="classsize__t.html">size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>number_of_species_</b></td></tr>
<tr class="separator:a19f730bebdeedd4bf8add8a4f10d10a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa06950adfb9b9adb44d41f1aa5653c0a"><td class="memItemLeft" align="right" valign="top"><a id="aa06950adfb9b9adb44d41f1aa5653c0a"></a>
std::map&lt; std::string, <a class="el" href="classsize__t.html">size_t</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>species_indexes_map_</b></td></tr>
<tr class="separator:aa06950adfb9b9adb44d41f1aa5653c0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d0595f84984af5ff951014901f3e732"><td class="memItemLeft" align="right" valign="top"><a id="a8d0595f84984af5ff951014901f3e732"></a>
StdVec&lt; <a class="el" href="class_s_p_h_1_1_base_diffusion.html">BaseDiffusion</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>species_diffusion_</b></td></tr>
<tr class="separator:a8d0595f84984af5ff951014901f3e732"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80772b5505043dd8504756f4e115b6b7"><td class="memItemLeft" align="right" valign="top"><a id="a80772b5505043dd8504756f4e115b6b7"></a>
<a class="el" href="class_s_p_h_1_1_base_reaction_model.html">BaseReactionModel</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>species_reaction_</b></td></tr>
<tr class="separator:a80772b5505043dd8504756f4e115b6b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class BaseMaterialType = BaseMaterial&gt;<br />
class SPH::DiffusionReaction&lt; BaseMaterialType &gt;</h3>

<p>Complex material for diffusion or/and reactions. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a1ffa4b3efb62dc2b8c7a4a453c7a49c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ffa4b3efb62dc2b8c7a4a453c7a49c1">&#9670;&nbsp;</a></span>DiffusionReaction() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class BaseMaterialType = BaseMaterial&gt; </div>
<div class="memtemplate">
template&lt;typename... ConstructorArgs&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_s_p_h_1_1_diffusion_reaction.html">SPH::DiffusionReaction</a>&lt; <a class="el" href="class_s_p_h_1_1_base_material_type.html">BaseMaterialType</a> &gt;::<a class="el" href="class_s_p_h_1_1_diffusion_reaction.html">DiffusionReaction</a> </td>
          <td>(</td>
          <td class="paramtype">StdVec&lt; std::string &gt;&#160;</td>
          <td class="paramname"><em>species_name_list</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">ConstructorArgs &amp;&amp;...&#160;</td>
          <td class="paramname"><em>args</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Constructor for material with diffusion only. </p>

</div>
</div>
<a id="a0b8e08b31fcb4799d350314496a106ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b8e08b31fcb4799d350314496a106ca">&#9670;&nbsp;</a></span>DiffusionReaction() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class BaseMaterialType = BaseMaterial&gt; </div>
<div class="memtemplate">
template&lt;typename... ConstructorArgs&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_s_p_h_1_1_diffusion_reaction.html">SPH::DiffusionReaction</a>&lt; <a class="el" href="class_s_p_h_1_1_base_material_type.html">BaseMaterialType</a> &gt;::<a class="el" href="class_s_p_h_1_1_diffusion_reaction.html">DiffusionReaction</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_s_p_h_1_1_base_reaction_model.html">BaseReactionModel</a> &amp;&#160;</td>
          <td class="paramname"><em>species_reaction</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">StdVec&lt; std::string &gt;&#160;</td>
          <td class="paramname"><em>species_name_list</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">ConstructorArgs &amp;&amp;...&#160;</td>
          <td class="paramname"><em>args</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Constructor for material with diffusion and reaction. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ae0df9513e12beb9add4f6176b46d1b54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0df9513e12beb9add4f6176b46d1b54">&#9670;&nbsp;</a></span>initializeAnDiffusion()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class BaseMaterialType = BaseMaterial&gt; </div>
<div class="memtemplate">
template&lt;class DiffusionType , typename... ConstructorArgs&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_s_p_h_1_1_diffusion_reaction.html">SPH::DiffusionReaction</a>&lt; <a class="el" href="class_s_p_h_1_1_base_material_type.html">BaseMaterialType</a> &gt;::initializeAnDiffusion </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>diffusion_species_name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>gradient_species_name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">ConstructorArgs &amp;&amp;...&#160;</td>
          <td class="paramname"><em>args</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Initialize a diffusion material. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>SPHINXsys/src/shared/materials/<a class="el" href="diffusion__reaction_8h_source.html">diffusion_reaction.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
